Add Best Practice guideline for partials/include #8608
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
👍 I like it. /cc @javiereguiluz please share your thoughts on this as you're the best practices master :) |
javiereguiluz
approved these changes
Nov 12, 2017
There was a problem hiding this comment.
I agree with this proposal! the leading underscore has been an unofficial best practice for more than 12 years (since symfony 1) so it's time to make it official!
If I may, I'd like to propose some minor rewordings to this proposal:
.. best-practice::
Prefix the file name of partial templates with an underscore.
You often want to reuse template code using the ``include()`` function to avoid
redundant code. To better differentiate those partials in the filesystem, you
should prefix their file names with a single underscore (e.g. ``_footer.html.twig``).Thanks!
|
I like it! Thank you Timon! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi there,
I was wondering if there is no Best Practice guide for partials/includes. So I would recommend to use a single prefixed underscore to determine such partials easily like in the Symfony demo application: https://github.com/symfony/demo/tree/master/templates/blog
I saw often other solutions like
@SomeBundle:Partials/post_form.html.twig. But I like the approach from the Symfony demo application, so it should be a Best Practice guideline :)Regards,
Timon